<div class="body-wrap">

<h1>Class <a href='source/jasmine.html#jasmine-Matchers'>jasmine.Matchers</a></h1>
<table cellspacing='0'>

<tr><td class='label'>Extends:</td><td class='hd-info'>Object</td></tr>

<tr><td class='label'>Defined In:</td><td class='hd-info'><a href='source/jasmine.html#jasmine-Matchers'>jasmine.js</a></td></tr>





</table>
<div class='description'>
</div>
<div class='hr'></div>

<a id='jasmine.Matchers-props'></a>
<h2>Public Properties</h2>
<table cellspacing='0' class='member-table'><tbody>
<tr><th colspan='2' class='sig-header'>Property</th><th class='msource-header'>Defined By</th></tr>
      <tr class='property-row  '>
        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
        <td class='sig'><a id='jasmine.Matchers-wasCalled'></a><b><a href='source/jasmine.html#jasmine-Matchers-property-wasCalled'>wasCalled</a></b> : Object<div class='mdesc'><p>@deprecated Use expect(xxx).toHaveBeenCalled() instead</p>
</div></td>
        <td class='msource'>Matchers</td>
      </tr>

      <tr class='property-row  '>
        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
        <td class='sig'><a id='jasmine.Matchers-wasCalledWith'></a><b><a href='source/jasmine.html#jasmine-Matchers-property-wasCalledWith'>wasCalledWith</a></b> : Object<div class='mdesc'><p>@deprecated Use expect(xxx).toHaveBeenCalledWith() instead</p>
</div></td>
        <td class='msource'>Matchers</td>
      </tr>

</tbody></table>
<a id='jasmine.Matchers-methods'></a>
<h2>Public Methods</h2>
<table cellspacing='0' class='member-table'><tbody>
<tr><th colspan='2' class='sig-header'>Method</th><th class='msource-header'>Defined By</th></tr>
      <tr class='method-row expandable '>
        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
        <td class='sig'><a id='jasmine.Matchers-Matchers'></a><b><a href='source/jasmine.html#jasmine-Matchers-method-constructor'>Matchers</a></b>( <code>jasmine.Env env</code>, <code>Object actual</code>, <code>jasmine.Spec spec</code> ) : void<div class='mdesc'><div class='short'>
</div><div class='long'>
<div class='mdetail-params'>
<strong>Parameters:</strong>
<ul><li><code>env</code> : jasmine.Env<div class='sub-desc'>
</div></li><li><code>actual</code> : Object<div class='sub-desc'>
</div></li><li><code>spec</code> : jasmine.Spec<div class='sub-desc'>
</div></li></ul>
<strong>Returns:</strong>
<ul><li><code>void</code><div class='sub-desc'>
</div></li></ul>
</div></div></div></td>
        <td class='msource'>Matchers</td>
      </tr>

      <tr class='method-row expandable '>
        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
        <td class='sig'><a id='jasmine.Matchers-toBe'></a><b><a href='source/jasmine.html#jasmine-Matchers-method-toBe'>toBe</a></b>( <code>Object expected</code> ) : void<div class='mdesc'><div class='short'><p>toBe: compares the actual to the expected using ===</p>
</div><div class='long'><p>toBe: compares the actual to the expected using ===</p>
<div class='mdetail-params'>
<strong>Parameters:</strong>
<ul><li><code>expected</code> : Object<div class='sub-desc'>
</div></li></ul>
<strong>Returns:</strong>
<ul><li><code>void</code><div class='sub-desc'>
</div></li></ul>
</div></div></div></td>
        <td class='msource'>Matchers</td>
      </tr>

      <tr class='method-row expandable '>
        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
        <td class='sig'><a id='jasmine.Matchers-toBeCloseTo'></a><b><a href='source/jasmine.html#jasmine-Matchers-method-toBeCloseTo'>toBeCloseTo</a></b>( <code>Number expected</code>, <code>Number precision</code> ) : void<div class='mdesc'><div class='short'>Matcher that checks that the expected item is equal to the actual item
up to a given level of decimal precision (defa...</div><div class='long'><p>Matcher that checks that the expected item is equal to the actual item
up to a given level of decimal precision (default 2).</p>
<div class='mdetail-params'>
<strong>Parameters:</strong>
<ul><li><code>expected</code> : Number<div class='sub-desc'>
</div></li><li><code>precision</code> : Number<div class='sub-desc'>
</div></li></ul>
<strong>Returns:</strong>
<ul><li><code>void</code><div class='sub-desc'>
</div></li></ul>
</div></div></div></td>
        <td class='msource'>Matchers</td>
      </tr>

      <tr class='method-row expandable '>
        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
        <td class='sig'><a id='jasmine.Matchers-toBeDefined'></a><b><a href='source/jasmine.html#jasmine-Matchers-method-toBeDefined'>toBeDefined</a></b>() : void<div class='mdesc'><div class='short'><p>Matcher that compares the actual to jasmine.undefined.</p>
</div><div class='long'><p>Matcher that compares the actual to jasmine.undefined.</p>
<div class='mdetail-params'>
<strong>Parameters:</strong>
<ul><li>None.</li></ul>
<strong>Returns:</strong>
<ul><li><code>void</code><div class='sub-desc'>
</div></li></ul>
</div></div></div></td>
        <td class='msource'>Matchers</td>
      </tr>

      <tr class='method-row expandable '>
        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
        <td class='sig'><a id='jasmine.Matchers-toBeFalsy'></a><b><a href='source/jasmine.html#jasmine-Matchers-method-toBeFalsy'>toBeFalsy</a></b>() : void<div class='mdesc'><div class='short'><p>Matcher that boolean nots the actual.</p>
</div><div class='long'><p>Matcher that boolean nots the actual.</p>
<div class='mdetail-params'>
<strong>Parameters:</strong>
<ul><li>None.</li></ul>
<strong>Returns:</strong>
<ul><li><code>void</code><div class='sub-desc'>
</div></li></ul>
</div></div></div></td>
        <td class='msource'>Matchers</td>
      </tr>

      <tr class='method-row expandable '>
        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
        <td class='sig'><a id='jasmine.Matchers-toBeNull'></a><b><a href='source/jasmine.html#jasmine-Matchers-method-toBeNull'>toBeNull</a></b>() : void<div class='mdesc'><div class='short'><p>Matcher that compares the actual to null.</p>
</div><div class='long'><p>Matcher that compares the actual to null.</p>
<div class='mdetail-params'>
<strong>Parameters:</strong>
<ul><li>None.</li></ul>
<strong>Returns:</strong>
<ul><li><code>void</code><div class='sub-desc'>
</div></li></ul>
</div></div></div></td>
        <td class='msource'>Matchers</td>
      </tr>

      <tr class='method-row expandable '>
        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
        <td class='sig'><a id='jasmine.Matchers-toBeTruthy'></a><b><a href='source/jasmine.html#jasmine-Matchers-method-toBeTruthy'>toBeTruthy</a></b>() : void<div class='mdesc'><div class='short'><p>Matcher that boolean not-nots the actual.</p>
</div><div class='long'><p>Matcher that boolean not-nots the actual.</p>
<div class='mdetail-params'>
<strong>Parameters:</strong>
<ul><li>None.</li></ul>
<strong>Returns:</strong>
<ul><li><code>void</code><div class='sub-desc'>
</div></li></ul>
</div></div></div></td>
        <td class='msource'>Matchers</td>
      </tr>

      <tr class='method-row expandable '>
        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
        <td class='sig'><a id='jasmine.Matchers-toBeUndefined'></a><b><a href='source/jasmine.html#jasmine-Matchers-method-toBeUndefined'>toBeUndefined</a></b>() : void<div class='mdesc'><div class='short'><p>Matcher that compares the actual to jasmine.undefined.</p>
</div><div class='long'><p>Matcher that compares the actual to jasmine.undefined.</p>
<div class='mdetail-params'>
<strong>Parameters:</strong>
<ul><li>None.</li></ul>
<strong>Returns:</strong>
<ul><li><code>void</code><div class='sub-desc'>
</div></li></ul>
</div></div></div></td>
        <td class='msource'>Matchers</td>
      </tr>

      <tr class='method-row expandable '>
        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
        <td class='sig'><a id='jasmine.Matchers-toContain'></a><b><a href='source/jasmine.html#jasmine-Matchers-method-toContain'>toContain</a></b>( <code>Object expected</code> ) : void<div class='mdesc'><div class='short'><p>Matcher that checks that the expected item is an element in the actual Array.</p>
</div><div class='long'><p>Matcher that checks that the expected item is an element in the actual Array.</p>
<div class='mdetail-params'>
<strong>Parameters:</strong>
<ul><li><code>expected</code> : Object<div class='sub-desc'>
</div></li></ul>
<strong>Returns:</strong>
<ul><li><code>void</code><div class='sub-desc'>
</div></li></ul>
</div></div></div></td>
        <td class='msource'>Matchers</td>
      </tr>

      <tr class='method-row expandable '>
        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
        <td class='sig'><a id='jasmine.Matchers-toEqual'></a><b><a href='source/jasmine.html#jasmine-Matchers-method-toEqual'>toEqual</a></b>( <code>Object expected</code> ) : void<div class='mdesc'><div class='short'><p>toEqual: compares the actual to the expected using common sense equality. Handles Objects, Arrays, etc.</p>
</div><div class='long'><p>toEqual: compares the actual to the expected using common sense equality. Handles Objects, Arrays, etc.</p>
<div class='mdetail-params'>
<strong>Parameters:</strong>
<ul><li><code>expected</code> : Object<div class='sub-desc'>
</div></li></ul>
<strong>Returns:</strong>
<ul><li><code>void</code><div class='sub-desc'>
</div></li></ul>
</div></div></div></td>
        <td class='msource'>Matchers</td>
      </tr>

      <tr class='method-row expandable '>
        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
        <td class='sig'><a id='jasmine.Matchers-toHaveBeenCalled'></a><b><a href='source/jasmine.html#jasmine-Matchers-method-toHaveBeenCalled'>toHaveBeenCalled</a></b>() : void<div class='mdesc'><div class='short'><p>Matcher that checks to see if the actual, a Jasmine spy, was called.</p>
</div><div class='long'><p>Matcher that checks to see if the actual, a Jasmine spy, was called.</p>
<div class='mdetail-params'>
<strong>Parameters:</strong>
<ul><li>None.</li></ul>
<strong>Returns:</strong>
<ul><li><code>void</code><div class='sub-desc'>
</div></li></ul>
</div></div></div></td>
        <td class='msource'>Matchers</td>
      </tr>

      <tr class='method-row expandable '>
        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
        <td class='sig'><a id='jasmine.Matchers-toHaveBeenCalledWith'></a><b><a href='source/jasmine.html#jasmine-Matchers-method-toHaveBeenCalledWith'>toHaveBeenCalledWith</a></b>() : void<div class='mdesc'><div class='short'><p>Matcher that checks to see if the actual, a Jasmine spy, was called with a set of parameters.</p>

<p>@example</p>
</div><div class='long'><p>Matcher that checks to see if the actual, a Jasmine spy, was called with a set of parameters.</p>

<p>@example</p>
<div class='mdetail-params'>
<strong>Parameters:</strong>
<ul><li>None.</li></ul>
<strong>Returns:</strong>
<ul><li><code>void</code><div class='sub-desc'>
</div></li></ul>
</div></div></div></td>
        <td class='msource'>Matchers</td>
      </tr>

      <tr class='method-row expandable '>
        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
        <td class='sig'><a id='jasmine.Matchers-toMatch'></a><b><a href='source/jasmine.html#jasmine-Matchers-method-toMatch'>toMatch</a></b>( <code>Object expected</code> ) : void<div class='mdesc'><div class='short'>Matcher that compares the actual to the expected using a regular expression.  Constructs a RegExp, so takes
a pattern...</div><div class='long'><p>Matcher that compares the actual to the expected using a regular expression.  Constructs a RegExp, so takes
a pattern or a String.</p>
<div class='mdetail-params'>
<strong>Parameters:</strong>
<ul><li><code>expected</code> : Object<div class='sub-desc'>
</div></li></ul>
<strong>Returns:</strong>
<ul><li><code>void</code><div class='sub-desc'>
</div></li></ul>
</div></div></div></td>
        <td class='msource'>Matchers</td>
      </tr>

      <tr class='method-row expandable '>
        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
        <td class='sig'><a id='jasmine.Matchers-toNotBe'></a><b><a href='source/jasmine.html#jasmine-Matchers-method-toNotBe'>toNotBe</a></b>( <code>Object expected</code> ) : void<div class='mdesc'><div class='short'><p>toNotBe: compares the actual to the expected using !==</p>
</div><div class='long'><p>toNotBe: compares the actual to the expected using !==</p>
<div class='mdetail-params'>
<strong>Parameters:</strong>
<ul><li><code>expected</code> : Object<div class='sub-desc'><p>@deprecated as of 1.0. Use not.toBe() instead.</p>
</div></li></ul>
<strong>Returns:</strong>
<ul><li><code>void</code><div class='sub-desc'>
</div></li></ul>
</div></div></div></td>
        <td class='msource'>Matchers</td>
      </tr>

      <tr class='method-row expandable '>
        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
        <td class='sig'><a id='jasmine.Matchers-toNotContain'></a><b><a href='source/jasmine.html#jasmine-Matchers-method-toNotContain'>toNotContain</a></b>( <code>Object expected</code> ) : void<div class='mdesc'><div class='short'><p>Matcher that checks that the expected item is NOT an element in the actual Array.</p>
</div><div class='long'><p>Matcher that checks that the expected item is NOT an element in the actual Array.</p>
<div class='mdetail-params'>
<strong>Parameters:</strong>
<ul><li><code>expected</code> : Object<div class='sub-desc'><p>@deprecated as of 1.0. Use not.toNotContain() instead.</p>
</div></li></ul>
<strong>Returns:</strong>
<ul><li><code>void</code><div class='sub-desc'>
</div></li></ul>
</div></div></div></td>
        <td class='msource'>Matchers</td>
      </tr>

      <tr class='method-row expandable '>
        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
        <td class='sig'><a id='jasmine.Matchers-toNotEqual'></a><b><a href='source/jasmine.html#jasmine-Matchers-method-toNotEqual'>toNotEqual</a></b>( <code>Object expected</code> ) : void<div class='mdesc'><div class='short'><p>toNotEqual: compares the actual to the expected using the ! of jasmine.Matchers.toEqual</p>
</div><div class='long'><p>toNotEqual: compares the actual to the expected using the ! of jasmine.Matchers.toEqual</p>
<div class='mdetail-params'>
<strong>Parameters:</strong>
<ul><li><code>expected</code> : Object<div class='sub-desc'><p>@deprecated as of 1.0. Use not.toNotEqual() instead.</p>
</div></li></ul>
<strong>Returns:</strong>
<ul><li><code>void</code><div class='sub-desc'>
</div></li></ul>
</div></div></div></td>
        <td class='msource'>Matchers</td>
      </tr>

      <tr class='method-row expandable '>
        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
        <td class='sig'><a id='jasmine.Matchers-toNotMatch'></a><b><a href='source/jasmine.html#jasmine-Matchers-method-toNotMatch'>toNotMatch</a></b>( <code>Object expected</code> ) : void<div class='mdesc'><div class='short'><p>Matcher that compares the actual to the expected using the boolean inverse of jasmine.Matchers.toMatch</p>
</div><div class='long'><p>Matcher that compares the actual to the expected using the boolean inverse of jasmine.Matchers.toMatch</p>
<div class='mdetail-params'>
<strong>Parameters:</strong>
<ul><li><code>expected</code> : Object<div class='sub-desc'><p>@deprecated as of 1.0. Use not.toMatch() instead.</p>
</div></li></ul>
<strong>Returns:</strong>
<ul><li><code>void</code><div class='sub-desc'>
</div></li></ul>
</div></div></div></td>
        <td class='msource'>Matchers</td>
      </tr>

      <tr class='method-row expandable '>
        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
        <td class='sig'><a id='jasmine.Matchers-toThrow'></a><b><a href='source/jasmine.html#jasmine-Matchers-method-toThrow'>toThrow</a></b>( <code>String expected</code> ) : void<div class='mdesc'><div class='short'><p>Matcher that checks that the expected exception was thrown by the actual.</p>
</div><div class='long'><p>Matcher that checks that the expected exception was thrown by the actual.</p>
<div class='mdetail-params'>
<strong>Parameters:</strong>
<ul><li><code>expected</code> : String<div class='sub-desc'>
</div></li></ul>
<strong>Returns:</strong>
<ul><li><code>void</code><div class='sub-desc'>
</div></li></ul>
</div></div></div></td>
        <td class='msource'>Matchers</td>
      </tr>

      <tr class='method-row expandable '>
        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
        <td class='sig'><a id='jasmine.Matchers-wasNotCalled'></a><b><a href='source/jasmine.html#jasmine-Matchers-method-wasNotCalled'>wasNotCalled</a></b>() : void<div class='mdesc'><div class='short'>Matcher that checks to see if the actual, a Jasmine spy, was not called.

@deprecated Use expect(xxx).not.toHaveBeenC...</div><div class='long'><p>Matcher that checks to see if the actual, a Jasmine spy, was not called.</p>

<p>@deprecated Use expect(xxx).not.toHaveBeenCalled() instead</p>
<div class='mdetail-params'>
<strong>Parameters:</strong>
<ul><li>None.</li></ul>
<strong>Returns:</strong>
<ul><li><code>void</code><div class='sub-desc'>
</div></li></ul>
</div></div></div></td>
        <td class='msource'>Matchers</td>
      </tr>

      <tr class='method-row expandable '>
        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
        <td class='sig'><a id='jasmine.Matchers-wasNotCalledWith'></a><b><a href='source/jasmine.html#jasmine-Matchers-method-wasNotCalledWith'>wasNotCalledWith</a></b>() : void<div class='mdesc'><div class='short'><p>@deprecated Use expect(xxx).not.toHaveBeenCalledWith() instead</p>
</div><div class='long'><p>@deprecated Use expect(xxx).not.toHaveBeenCalledWith() instead</p>
<div class='mdetail-params'>
<strong>Parameters:</strong>
<ul><li>None.</li></ul>
<strong>Returns:</strong>
<ul><li><code>void</code><div class='sub-desc'>
</div></li></ul>
</div></div></div></td>
        <td class='msource'>Matchers</td>
      </tr>

</tbody></table>

</div>